-
Notifications
You must be signed in to change notification settings - Fork 22.7k
Add an example to search for multi-byte pattern in an array #39479
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
def00111
wants to merge
24
commits into
mdn:main
Choose a base branch
from
def00111:patch-17
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+140
−0
Open
Changes from 3 commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
29f071f
Add an example to search for multi-byte pattern in an array
def00111 163c953
Update index.md
def00111 3f50141
Update index.md
def00111 234d195
Update example
def00111 171cfe2
Update example
def00111 7610ab6
Update example
def00111 1a987e4
Update example
def00111 d376839
Update example
def00111 d1941c2
Update example
def00111 58c9c75
Update example
def00111 221205a
Update example
def00111 0f18979
Update example
def00111 a3861f4
Update example
def00111 ec57ec4
Update example
def00111 733a893
Update example
def00111 c090a53
Update example
def00111 cc8beca
Update example
def00111 55d6078
Apply suggestions from code review
def00111 a57ebc9
Update example
def00111 2f78c3a
Update example
def00111 66e0312
Apply suggestions from code review
def00111 9756534
Update example
def00111 1fc53ce
Update example
def00111 eef7882
Update example
def00111 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -315,6 +315,60 @@ browser.webRequest.onBeforeRequest.addListener( | |
); | ||
``` | ||
|
||
This example demonstrates, how to search for multi-byte pattern in an array: | ||
|
||
```js | ||
Array.prototype.indexOfMulti = function (searchElements, fromIndex) { | ||
let i = this.indexOf(searchElements[0], fromIndex); | ||
if (searchElements.length === 1 || i === -1) { | ||
// Not found or no other elements to check | ||
return i; | ||
} | ||
|
||
const initial = i; | ||
for (let j = 1; j < searchElements.length && i < this.length; j++) { | ||
if (this[++i] !== searchElements[j]) { | ||
return this.indexOfMulti(searchElements, initial + 1); | ||
} | ||
} | ||
|
||
return i === initial + searchElements.length - 1 ? initial : -1; | ||
}; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Modifying built-in prototypes is generally considered an anti-pattern. There's no clear benefit to this approach over using a standalone function. |
||
|
||
const encoder = new TextEncoder(); | ||
const elements = encoder.encode("WebExtension "); | ||
const bytes = encoder.encode("Example"); | ||
|
||
function listener(details) { | ||
const filter = browser.webRequest.filterResponseData(details.requestId); | ||
|
||
const data = []; | ||
filter.ondata = (event) => { | ||
const buffer = new Uint8Array(event.data); | ||
for (let i = 0, l = buffer.length; i < l; i++) { | ||
data.push(buffer[i]); | ||
} | ||
}; | ||
|
||
filter.onstop = (event) => { | ||
let i, pos; | ||
while ((i = data.indexOfMulti(bytes, pos)) !== -1) { | ||
data.splice(i, 0, ...elements); | ||
pos = i + elements.length + bytes.length; | ||
} | ||
|
||
filter.write(new Uint8Array(data)); | ||
filter.close(); | ||
}; | ||
} | ||
|
||
browser.webRequest.onBeforeRequest.addListener( | ||
listener, | ||
{ urls: ["https://example.com/"], types: ["main_frame"] }, | ||
["blocking"], | ||
); | ||
``` | ||
|
||
{{WebExtExamples}} | ||
|
||
## Browser compatibility | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This example is very large now. Should it be on https://github.com/mdn/webextensions-examples?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@def00111 yes, I think this is now getting to the point where we need to move it out of the documentation into a web extensions example.